home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / rando100.arc / RANDO.DOC < prev    next >
Text File  |  1991-12-29  |  12KB  |  276 lines
  1.  
  2.     RANDO - RANDom Origin file maintenance
  3.  
  4.     Written by: Don Dawson, 1:141/730 @FidoNet            August, 1991
  5.  
  6.     This program is distributed under the Dinnerware concept.  You
  7.     might ask, what's Dinnerware?  You might know of Shareware and
  8.     Freeware.  The Dinnerware concept is this:  You don't owe me or
  9.     anyone else a thing if you choose to use this program.  However,
  10.     take your spouse, significant other, best friend or anyone
  11.     else you choose out to dinner.  You'll enjoy it, they'll enjoy it.
  12.  
  13.                              or
  14.     
  15.     Can't afford dinner?  Send a Thank You note/message to the person
  16.     that helped you set up your bbs or sent this program to you. It'll
  17.     only take a minute.
  18.  
  19.     THIS MATERIAL IS DISTRIBUTED "as is" WITHOUT ANY EXPRESSED OR
  20.     IMPLIED WARRANTY OR LIABILITY FOR DIRECT, INDIRECT OR
  21.     (IN)CONSEQUENTIAL DAMAGES.  If it breaks, you own ALL the parts.
  22.     (see SOCIAL COMMENTARY below)
  23.  
  24.     OVERVIEW:
  25.  
  26.     Why RANDO?  Rando will create random ORIGIN files in each of your
  27.     echomail areas.  Some message editors (MSGED for sure) and some FidoNet
  28.     BBS software (OPUS 1.70) will use this file to create a 'custom' origin
  29.     line instead of the same one in every echo.
  30.  
  31.     SOCIAL COMMENTARY:
  32.     
  33.     Before going on, a word from your Sponsor. <g>
  34.         
  35.     The * Origin line *does* serve a purpose.  It's to identify the node #
  36.     from which an echomail message originated.  Most sysops use something
  37.     appropriate for their bbs.  Here's the one my BBS uses when an echomail
  38.     message originates from 1:141/730:
  39.  
  40.      * Origin: Treasure Island =HST/DS= 203-791-8532 (1:141/730)
  41.  
  42.     If you use RANDO, please use tasteful (humorous?) material.  I don't
  43.     recommend letting your BBS use the RANDO origin lines.  Why?  Although
  44.     your material may be appropriate, there's no telling if it's appropriate
  45.     for the context of the message that a caller writes.  I only use this
  46.     for messages that I write with my external message editor.  If the Origin
  47.     isn't appropriate for the message context, I can use the editor to change
  48.     it.  A BBS caller can't do this.  Besides, how many of them read 'em
  49.     anyway?
  50.     
  51.     Here's an example using an Origin from the enclosed file:
  52.     
  53.     A caller writes:
  54.     
  55.     I NEVER beat my wife!
  56.     
  57.     Your BBS adds this as an Origin:
  58.     
  59.     * Origin: To every exception there is a rule. (1:9999/9999)
  60.  
  61.     Get the idea? 
  62.     
  63.     Enjoy!    
  64.  
  65.     HOW IT WORKS:
  66.  
  67.     It will read a file (of up to 1000 lines) and randomly write an
  68.     ORIGIN (no extension) or <areaname>.sqo (for squish areas) file into
  69.     each echo area.  Passthru echo areas are skipped (those with a # anywhere
  70.     on the AREAS.BBS line).
  71.     
  72.     Note:  See below if you don't have an AREAS.BBS file.
  73.     
  74.     Of course, it reads the AREAS.BBS to find the path to each echomail
  75.     directory.  For creative and "what's an AREAS.BBS?" users please see
  76.     below.
  77.         
  78.     Because "high bit" characters (greater than ASCII 127) are frowned
  79.     upon in any Zone 1 echomail, if the input file contains any such
  80.     characters the characters will be replaced with a + or a -.  Any lines
  81.     longer than 44 characters will be skipped and will be written to an
  82.     'error file' so you can either delete them or edit them to make the
  83.     lines shorter.  Why 44 characters?  Origin lines must be a single
  84.     line.  Multiple lines are not appreciated.  Allowing for the beginning
  85.     *Origin stuff and the ending (1:xxx/yyy@fidonet.org) 44 should do it.
  86.  
  87.     USING RANDO:
  88.  
  89.     You must provide two command line parameters, optionally five more,
  90.     seperated by a space (UPPER, lower or MiXeD case are ok).  If you
  91.     run it without anything on the command line you'll get something
  92.     like this:
  93.  
  94.           ╒════════════════════════════════════════════════════════╕
  95.           │            RANDO v1.00 - Random Origin lines           │
  96.           │  (C) Copyright 1991 by Don Dawson 1:141/730.0@Fidonet  │
  97.           ╘════════════════════════════════════════════════════════╛
  98.  
  99.  
  100. Usage: [-a\path\filename] [-q\path\filename] [-e\path\filename]
  101.         [-x\path\filename] [-l] [-b] [-s]
  102.  
  103.   -a [path and file name of AREAS.BBS]
  104.      ex:. -ac:\misc\areas.bbs
  105.   -q [path and file name of quotes file]
  106.      ex:  -qc:\misc\quotes.lst
  107.   -e [path and file name of quotes error file] (optional)
  108.      ex:  -ec:\misc\rando.err
  109.   -x [path and file name of areas to eXclude (optional)
  110.      ex:  -xc:\misc\skipem.lst
  111.   -b BBS name from the AREAS.BBS file will be prefixed to the origin line.
  112.      ex:  -b
  113.   -s Run silently.
  114.      ex:  -s
  115.   -l Write rando.log containing \yourpath\ and each origin line.
  116.      ex:  -l
  117.    
  118.         . -A  the name and path to your AREAS.BBS file (required).
  119.  
  120.         . -Q  the name and path to the file that contains the stuff
  121.               (famous quotes?) you want to use in your *Origin line.
  122.               (required)
  123.  
  124.         . -E  the name and path to a file into which you'd like all
  125.               "errors" in your quote file written. (optional)
  126.  
  127.         . -X  the name and path to a file containing areas you would
  128.               like eXcluded from processing.  It must be in 'areas.bbs'
  129.               file format.  As a matter of fact, you can make a copy
  130.               of your areas.bbs file and delete or comment out the areas
  131.               that you want included.  Everything left in the file will
  132.               be excluded. (optional)
  133.  
  134.         . -B  This will prefix the contents of the origin file with your
  135.               BBS name.  The BBS name is the same one that's in your
  136.               areas.bbs (probably on the first line).  Everything up to
  137.               the '!' will be included. WARNING: Your BBS name must be
  138.               less than 44 characters.  If your BBS name + a randomly
  139.               selected line from the origin file is greater than 44 
  140.               characters, only your BBS name will be used for that origin
  141.               file. (optional)
  142.               
  143.         .  -S This will avoid displaying the paths to the origin line files
  144.               as the program runs.  The program will run a little quicker if
  145.               you use this. (optional)
  146.  
  147.         . -L  Log into RANDO.LOG each path and origin file contents.
  148.               (optional)
  149.  
  150.     EXAMPLES:
  151.  
  152.     rando -ac:\bbs\areas.bbs -qc:\bbs\quotes.txt -s
  153.  
  154.             Note: No trailing backslash following the file name(s).
  155.  
  156.     rando -ac:\misc\myareas.bbs -qd:\stuff\myorigin.bbs -ec:\junk\errors.lst
  157.  
  158.             This will write 'input file errors' to the ERRORS.LST file.
  159.  
  160.     rando -ac:\bbs\areas.bbs -qc:\bbs\quotes.txt -b
  161.     
  162.             Your BBS name will be prefixed to the contents of each origin
  163.             line in each ORIGIN file.
  164.  
  165.     CREATIVE USERS or "What's an areas.bbs"?
  166.     
  167.     An areas.bbs file looks like this:
  168.     
  169. Treasure Island ! Don Dawson
  170. $f:\msg\141STUFF  141STUFF        141/740 701
  171. f:\msg\141SYSOP  141SYSOP        141/740 701
  172. f:\msg\4DOS      4DOS            141/740 701
  173. f:\msg\80XXX     80XXX           141/740 775
  174. f:\msg\ANEWS     ANEWS  #        141/565 740 123/45
  175. #f:\msg\ANIME    ANIME           141/740 701
  176.  
  177. The first line has: the BBS name, a 'space ! space', sysop name.
  178.  
  179. The following lines have \yourpath and the AREATAG.
  180.  
  181. The # indicates a 'passthru' area.
  182.  
  183. The $ indicates a 'squishmail' area. (Yes, you can mix and match sq/msg).
  184.  
  185. RANDO is really only interested in one thing, the path to the directory
  186. into which to write the ORIGIN file.  If an area is 'passthru' (#), an
  187. ORIGIN file will not be created in that directory. Everything else is
  188. ignored.
  189.  
  190. If you want to be creative, you can do this:
  191.  
  192. Make two or more "fake areas.bbs" files, name them anything you want. For
  193. example: you might have a collection of origin lines that you want to use
  194. only in your sysop echos, another set in other echoes.  Run RANDO once for
  195. each group.  Like this:
  196.  
  197. For the sysop echoes:
  198.  
  199. rando -ac:\files\sysop.bbs -qc:\files\sysop.qte -s
  200. rando -ac:\files\others.bbs -qc:\files\other.qte -s
  201.  
  202.     Kudos to the Beta Testers:
  203.     
  204.     My thanks to the fine folks that took the risk and tested RANDO:
  205.     
  206.     Rob Schmaling, 141/765
  207.     Steve Plain,   141/980
  208.     Gary Snider,   141/740
  209.     Noel Smith,    141/945
  210.     Rudy Ramsey,   141/755
  211.     Paul Brazil,   141/710
  212.     Furlan Primus, 141/590
  213. ------------------------------------------------------------------------------
  214.  
  215. Revision History:
  216.  
  217. Version .01  5/25/91, the original
  218.         .02  5/26/91, made the display different
  219.         .03  5/28/91, added -x and -b options
  220.         .04  never released
  221.         .05  7/31/91, improved command line processing and an origin line
  222.              will not be repeated as long as there are at least the same
  223.              number (or more) of origin lines as there are areas.
  224.         .06  7/31/91, removed test code (OOPS!).  More 'error checking'
  225.              improvements.
  226.         .07  8/3/91, updated the docs.  Thanks to Gary Snider for the
  227.              "creative users" idea.
  228.              .  Documentation update.
  229.              .  It will now process files that contain '-' in the file
  230.                 name or path.
  231.              .  The 'errorfil' is renamed to rando.err.
  232.              .  Improved reporting of non-existent paths in the AREAS.BBS
  233.                 file.
  234.         .08  8/7/91, minor fixes:
  235.              . The RANDO.ERR file will only be created when there are
  236.                 errors instead of with every execution.  (Thanks Furlan!)
  237.              . Fixed a minor mite that would result in writing an empty
  238.                ORIGIN file if there were fewer quote lines than when there
  239.                were areas to write to.
  240.         .09  8/8/91, minor enhancement (requested):
  241.              . added -l command line option
  242.              . minor documentation fixes
  243.         .091 8/12/91, 2 mites fixed
  244.              . if -b was selected some long origin lines were not detected.
  245.              . the "error.log" is erased each time.
  246.         .092 8/13/91, minor enhancements
  247.              .  The rando.log is erased each run.
  248.              .  The -s (silent) and -l (log) options are now independent
  249.                 of each other.
  250.              .  The -l option no longer lists to the screen.
  251.              .  Minor doc updates.
  252.         .093 11/22/91
  253.              .  Will now skip Squish areas.  It looks for a $ in the path
  254.                 to an echo area.  Like this:
  255.                 
  256.                 $f:\msg\AVIATION  AVIATION        141/740
  257.                 
  258.                 ORIGIN in not supported in Maximus 2.0 <sigh>
  259.  
  260.         1.00 12/26/91
  261.              .  Well....no bug reports from anyone and none noted here.  Time
  262.                 to make the plunge with a version 1.00!
  263.              .  Good news!  ORIGIN *is* supported in Maximus 2.0.  It's an
  264.                 un-documented feature.  RANdO will now create an ?.sqo for
  265.                 each squish area.  I don't know how to get Maximus itself
  266.                 to use ?.sqo, but stand alone message editors should.
  267.              .  For each line in AREAS.BBS that begins with a $, the ?.sqo
  268.                 will be created.  For example, this area:
  269.                 
  270.                 $f:\om\AVIATION  AVIATION        141/740
  271.  
  272.                 will have an AVIATION.SQO file created in the same directory
  273.                 as all of the other AVIATION.SQ? files.
  274.  
  275.               . Minor DOC update.
  276.